Broaden receive data buffer types#197
Open
Mirochill wants to merge 1 commit into
Open
Conversation
GalaxySnail
reviewed
May 19, 2026
| return (bytes(self._receive_buffer), self._receive_buffer_closed) | ||
|
|
||
| def receive_data(self, data: bytes) -> None: | ||
| def receive_data(self, data: Union[bytes, bytearray, memoryview]) -> None: |
Contributor
There was a problem hiding this comment.
It would be better to use collections.abc.Buffer for Python >= 3.12, as introduced in PEP 688. Alternatively, you can use if typing.TYPE_CHECKING: from typing_extensions import Buffer, which avoids a runtime dependency on typing_extensions.
|
|
||
| def __iadd__(self, byteslike: Union[bytes, bytearray]) -> "ReceiveBuffer": | ||
| def __iadd__( | ||
| self, byteslike: Union[bytes, bytearray, memoryview] |
|
|
||
|
|
||
| @pytest.mark.parametrize("data_wrapper", [bytearray, memoryview]) | ||
| def test_receive_data_accepts_byteslike_objects(data_wrapper: Any) -> None: |
Contributor
There was a problem hiding this comment.
Does this parameter need to be Any?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Connection.receive_data()and the internal receive buffer annotations to acceptbytearrayandmemoryviewalongsidebytesWhy
Issue #186 points out that
receive_data()already operates on bytes-like input, but its public annotation is still narrower than the runtime behavior. Widening the concrete accepted types removes false positives for downstream users adopting stricter bytes checking while keeping this patch intentionally small for h11's current typing/tooling baseline.Validation
Connection.receive_data()forwards directly intoReceiveBuffer.__iadd__().git diff --check.Fixes #186.